Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Updates #1317

Merged
merged 22 commits into from
Mar 24, 2025
Merged

Documentation Updates #1317

merged 22 commits into from
Mar 24, 2025

Conversation

TimPansino
Copy link
Contributor

@TimPansino TimPansino commented Mar 3, 2025 •
edited
Loading

Overview

  • Update docs to conform more closely with repo template.
  • Swap all RST files to Markdown for easier compatibility.
    • Converted using Pandoc, then edited.
    • Drop unused RST linters.
  • Removed dead ROADMAP.md file.
  • Removed dead links, and replaced with live ones.
    • learn.newrelic.com is currently rejecting curl requests, and is falsely showing as dead. It's definitely still reachable when visited in a browser.

@TimPansino TimPansino requested a review from a team as a code owner March 3, 2025 21:06
@mergify mergify bot removed the merge-conflicts label Mar 3, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 3, 2025 •
edited
Loading

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdownlint 7 0 0 0.76s
❌ MARKDOWN markdown-link-check 7 2 18.19s
❌ PYTHON ruff yes yes 1 0.23s
✅ YAML prettier 10 1 0 0.81s
✅ YAML v8r 10 0 4.66s
✅ YAML yamllint 10 0 0.52s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@codecov-commenter
Copy link

codecov-commenter commented Mar 3, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.07%. Comparing base (eb8d44b) to head (32b21c7).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1317      +/-   ##
==========================================
- Coverage   81.36%   80.07%   -1.29%     
==========================================
  Files         203      203              
  Lines       22641    22641              
  Branches     3574     3574              
==========================================
- Hits        18421    18129     -292     
- Misses       3029     3348     +319     
+ Partials     1191     1164      -27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mergify mergify bot added the tests-failing label Mar 3, 2025
@mergify mergify bot removed the tests-failing label Mar 4, 2025
@mergify mergify bot added the tests-failing label Mar 6, 2025
@mergify mergify bot removed the tests-failing label Mar 7, 2025
umaannamalai
umaannamalai approved these changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@umaannamalai umaannamalai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@TimPansino TimPansino merged commit 69fccdc into main Mar 24, 2025
44 of 57 checks passed
@TimPansino TimPansino deleted the fix-docs-linting branch March 24, 2025 19:49
@mergify mergify bot removed the tests-failing label Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@umaannamalai umaannamalai umaannamalai approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@TimPansino @codecov-commenter @umaannamalai